「PSR 规范」PSR-1 基础编码规范

    关于「能愿动词」的使用

    为了避免歧义，文档大量使用了「能愿动词」，对应的解释如下：

    • ：绝对，严格遵循，请照做，无条件遵守；
    • 一定不可 (MUST NOT)：禁令，严令禁止；
    • 应该 (SHOULD) ：强烈建议这样做，但是不强求；
    • 不该 (SHOULD NOT)：强烈不建议这样做，但是不强求；
    • 可以 (MAY) 和 可选 (OPTIONAL) ：选择性高一点，在这个文档内，此词语使用较少；

    • PHP代码文件 必须 以 <?php 或 <?= 标签开始；

    • PHP代码文件 必须 以 编码；

    • PHP代码中 应该 只定义类、函数、常量等声明，或其他会产生 副作用 的操作（如：生成文件输出以及修改 .ini 配置文件等），二者只能选其一；

    • 命名空间以及类 必须 符合 PSR 的自动加载规范： 中的一个；

    • 类中的常量所有字母都 必须 大写，单词间用下划线分隔；

    2. 文件

    PHP代码 必须 使用 <?php ?> 长标签 或 <?= ?> 短输出标签；
    一定不可 使用其它自定义标签。

    2.2. 字符编码

    PHP代码 必须 且只可使用 不带BOM的UTF-8 编码。

    一份 PHP 文件中 应该 要不就只定义新的声明，如类、函数或常量等不产生 副作用 的操作，要不就只书写会产生 的逻辑操作，但 不该 同时具有两者。

    「副作用」(side effects) 一词的意思是，仅仅通过包含文件，不直接声明类、函数和常量等，而执行的逻辑操作。

    「副作用」包含却不仅限于：

    • 生成输出
    • 直接的 require 或 include
    • 连接外部服务
    • 修改 ini 配置
    • 抛出错误或异常
    • 修改全局或静态变量
    • 读或写文件等

    以下是一个 反例，一份包含「函数声明」以及产生「副作用」的代码：

    下面是一个范例，一份只包含声明不产生「副作用」的代码：

    命名空间以及类的命名必须遵循 PSR-4。

    类的命名 必须 遵循 StudlyCaps 大写开头的驼峰命名规范。

    PHP 5.3 及以后版本的代码 必须 使用正式的命名空间。

    例如：

    5.2.x 及之前的版本 应该 使用伪命名空间的写法，约定俗成使用顶级的组织名称（vendor name）如 Vendor_ 为类前缀。

    4. 类的常量、属性和方法

    此处的「类」指代所有的类、接口以及可复用代码块（traits）。

    4.1. 常量

    类的常量中所有字母都 必须 大写，词间以下划线分隔。

    参照以下代码：

    类的属性命名 可以 遵循：

    • 大写开头的驼峰式 ($StudlyCaps)
    • 下划线分隔式 ()

    4.3. 方法

    方法名称 必须 符合 camelCase() 式的小写开头驼峰命名规范。